Add AGENTS.md for AI agent onboarding by RamLavi · Pull Request #2663 · kubevirt/cluster-network-addons-operator

RamLavi · 2026-04-05T06:31:29Z

What this PR does / why we need it:
This PR adds an AGENTS.md to the repo

This provides project structure, build/test commands, Go conventions, and development workflow context for AI coding agents.

Special notes for your reviewer:

Release note:

NONE

RamLavi · 2026-04-05T07:37:08Z

/retest

RamLavi · 2026-04-05T09:16:47Z

regarding the flake, I opened an issue on kubvirt/kubevirt kubevirt/kubevirt#17397

RamLavi · 2026-04-09T12:27:17Z

@maiqueb can you take a look?

ormergi

Thanks for the PR, please see my comments

ormergi · 2026-04-09T12:36:30Z

+
+Cluster Network Addons Operator (CNAO) is a Kubernetes operator that deploys and manages networking add-on components on Kubernetes and OpenShift clusters. It provides a single `NetworkAddonsConfig` CRD to declaratively manage the lifecycle of multiple network plugins, including upgrades, monitoring, and placement configuration.
+
+## Architecture


nit: rm empty header

ormergi · 2026-04-09T12:40:05Z

+### Core Components
+
+- **cmd/manager/** - Operator entry point; sets up the controller-runtime manager, scheme, metrics server, and health probes
+- **pkg/controller/networkaddonsconfig/** - Main reconciliation loop (`networkaddonsconfig_controller.go`) and pod controller for status tracking


nit: I would omit the "reconciliation" wording, this is controller-runtime jargon that could confuse the model and increase its potential for slops.
The critical part saying its the NAC controller is already there.

I'm confused, do you mean MAC controller?

network-addons-config CRD controller

Change the wording

ormergi · 2026-04-09T12:43:45Z

@@ -0,0 +1,175 @@
+This file provides guidance when working with code in this repository.
+
+## Repository Overview


I think this part should cover what the repository consist of, for example:

CNAO operator code

Fetch and generate installation manifests for each component it manages (via the components.yaml)

e2e tests

development/test environment setup

installation manifests

Please consider removing the NetworkAddonsConfig part its already exist in "How It Works"

DONE, is that OK now?

Yes, thanks

ormergi · 2026-04-09T12:50:56Z

+tools/                Build helpers (bumper, manifest-templator, metrics docs)
+cluster/              Local dev cluster management (kubevirtci)
+manifests/            Release manifests for OLM
+templates/            CSV templates


CSV templetes is pretty ambiguous, please add more context at least saying these are manifests for deploying the project with Operator-Lifecycle-Manager

ormergi · 2026-04-09T12:53:10Z

+
+- **Go version**: 1.25 (max allowed; auto-installed to `build/_output/bin/go/` via `hack/install-go.sh`)
+- **Build flags**: `GOFLAGS=-mod=vendor GO111MODULE=on CGO_ENABLED=0`
+- **Linting**: golangci-lint v2 with 30+ linters (see `.golangci.yml`)


Linters are not actual part of the build toolchain, and its external tool (outside Go binary). Please consider removing this part.

Provides project structure, build/test commands, Go conventions, and development workflow context for AI coding agents. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ram Lavi <ralavi@redhat.com>

RamLavi · 2026-04-13T12:07:02Z

Change: Address @ormergi's review

sonarqubecloud · 2026-04-13T12:07:08Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ormergi · 2026-04-13T12:25:48Z

+### Core Components
+
+- **cmd/manager/** - Operator entry point; sets up the controller-runtime manager, scheme, metrics server, and health probes
+- **pkg/controller/networkaddonsconfig/** - Main controller loop (`networkaddonsconfig_controller.go`) and pod controller for status tracking


nit:
How about:

Suggested change

- **pkg/controller/networkaddonsconfig/** - Main controller loop (`networkaddonsconfig_controller.go`) and pod controller for status tracking

- **pkg/controller/networkaddonsconfig/** - NetworkAddonsConfig resource controller. The project main controller.

ormergi · 2026-04-13T12:26:12Z

/lgtm

RamLavi · 2026-04-13T12:33:28Z

/approve

kubevirt-bot · 2026-04-13T12:33:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RamLavi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [RamLavi]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Apr 5, 2026

kubevirt-bot requested review from oshoval and phoracek April 5, 2026 06:31

kubevirt-bot added the size/L label Apr 5, 2026

ormergi reviewed Apr 9, 2026

View reviewed changes

Add AGENTS.md for AI agent onboarding

85e83bc

Provides project structure, build/test commands, Go conventions, and development workflow context for AI coding agents. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ram Lavi <ralavi@redhat.com>

RamLavi force-pushed the add_agents_md branch from 95ec948 to 85e83bc Compare April 13, 2026 12:06

ormergi reviewed Apr 13, 2026

View reviewed changes

kubevirt-bot assigned ormergi Apr 13, 2026

kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 13, 2026

kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 13, 2026

kubevirt-bot merged commit 8617ecf into kubevirt:main Apr 13, 2026
16 checks passed


		Cluster Network Addons Operator (CNAO) is a Kubernetes operator that deploys and manages networking add-on components on Kubernetes and OpenShift clusters. It provides a single `NetworkAddonsConfig` CRD to declaratively manage the lifecycle of multiple network plugins, including upgrades, monitoring, and placement configuration.

		## Architecture

		@@ -0,0 +1,175 @@
		This file provides guidance when working with code in this repository.

		## Repository Overview

	- pkg/controller/networkaddonsconfig/ - Main controller loop (`networkaddonsconfig_controller.go`) and pod controller for status tracking
	- pkg/controller/networkaddonsconfig/ - NetworkAddonsConfig resource controller. The project main controller.

Conversation

RamLavi commented Apr 5, 2026

Uh oh!

RamLavi commented Apr 5, 2026

Uh oh!

RamLavi commented Apr 5, 2026

Uh oh!

RamLavi commented Apr 9, 2026

Uh oh!

ormergi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RamLavi Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ormergi Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RamLavi commented Apr 13, 2026

Uh oh!

sonarqubecloud bot commented Apr 13, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ormergi commented Apr 13, 2026

Uh oh!

RamLavi commented Apr 13, 2026

Uh oh!

kubevirt-bot commented Apr 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RamLavi Apr 13, 2026 •

edited

Loading

ormergi Apr 9, 2026 •

edited

Loading